Allow multiple summaries per pull request #53
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lagru
commented
Nov 10, 2023
The new dataclass ChangeNote helps with uncoupling the `_query.py` logic and the `_format.py` logic from each other somewhat. In this case one pull request can be turned into multiple change notes which might appear in separate sections. This optional behavior allows to deal with somewhat large or unfocused pull requests. Long-term this step would also be necessary in case PyGitHub is replaced with a GraphQl-based approach.
The new dataclass Contributor helps with uncoupling the `_query.py` logic and the `_format.py` logic from each other somewhat. Long-term this step would also be necessary in case PyGitHub is replaced with a GraphQl-based approach.
Querying and formatting might generate warnings. Make sure that these are printed before the generated notes.
lagru
force-pushed
the
multiple-summaries
branch
from
a89f0ed
to
72e88ce
Compare
This is nothing to fancy but it should catch unexpected changes in our formatting logic and cover the happy path.
lagru
force-pushed
the
multiple-summaries
branch
3 times, most recently
from
9e88b20
to
bc5fef4
Compare
lagru
force-pushed
the
multiple-summaries
branch
from
bc5fef4
to
62cbdac
Compare
|
Okay, finally Python 3.9 is happy (sorry for the notification noise). I think this is ready to merge. As a real world example, this includes just the merge commit from scikit-image/scikit-image#6695 and creates the following notes: Details# scikit-image x.y.z
We're happy to announce the release of scikit-image x.y.z!
## New Features
- Add parameter `mode` to `binary_erosion`, `binary_dilation`, `binary_opening` and `binary_closing` in`skimage.morphology`. These new parameters determine how array borders are handled ([#6695](https://github.com/scikit-image/scikit-image/pull/6695)).
- Add parameters `mode` and `cval` to `erosion`, `dilation`, `opening`, `closing`, `white_tophat`, and `black_tophat` in `skimage.morphology`. These new parameters determine how array borders are handled ([#6695](https://github.com/scikit-image/scikit-image/pull/6695)).
- Add functions `mirror_footprint` and `pad_footprint` to `skimage.morphology` ([#6695](https://github.com/scikit-image/scikit-image/pull/6695)).
## API Changes
- Parameters `shift_x` and `shift_y` in `skimage.morphology.erosion` and `skimage.morphology.dilation` are deprecated. Use `pad_footprint` or modify the footprint manually instead ([#6695](https://github.com/scikit-image/scikit-image/pull/6695)).
## Bug Fixes
- Ensure `skimage.morphology.closing` and `skimage.morphology.opening` are extensive and anti-extensive, respectively, if the footprint is not mirror symmetric ([#6695](https://github.com/scikit-image/scikit-image/pull/6695)).
## Contributors
2 authors added to this release (alphabetically):
- Cris Luengo ([@crisluengo](https://github.com/crisluengo))
- Lars Grüter ([@lagru](https://github.com/lagru))
3 reviewers added to this release (alphabetically):
- Cris Luengo ([@crisluengo](https://github.com/crisluengo))
- Lars Grüter ([@lagru](https://github.com/lagru))
- Stefan van der Walt ([@stefanv](https://github.com/stefanv))
_These lists are automatically generated, and may not be complete or may contain
duplicates._Let me know what you think. :) |
|
@stefanv, could I ask you to have a look at this if you have the time? 🙏 Not the highest priority in my opinion but I'd hate to rush this just before our next skimage release. |
Co-authored-by: Stefan van der Walt <[email protected]>
Co-authored-by: Stefan van der Walt <[email protected]>
|
@lagru Let me know if you intend to make any other changes, otherwise I'll merge. |
This syntax should hopefully be more robust than the previous one based on the relatively common ":" character.
|
@stefanv. I've addressed all your comments and switched to the I've also added basic tests for this in |
Attempts to make the usage of the new feature clearer.
|
As we talked about, I've added a section in the README to document the new feature and make it clearer how to use it. It's duplicating the documentation in the config a little bit, but it's probably less hidden this way and should read nicer (no talk of regex). |
stefanv
approved these changes
Jan 26, 2024
lagru
commented
Jan 28, 2024
Comment on lines
+43
to
+46
| By default, changelist will fall back to the title of a pull request and its | ||
| GitHub labels to sort it into the appropriate section. However, if you want | ||
| longer summaries of your changes you can add a code block with the following | ||
| form anywhere in the description of the pull request: |
There was a problem hiding this comment.
@stefanv, re #53 (review): yes, overriding the title is documented.
stefanv
reviewed
Jan 29, 2024
stefanv
approved these changes
Jan 29, 2024
Co-authored-by: Stefan van der Walt <[email protected]>
|
Thanks Lars! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Tackles the first case in #45:
It would be good to have this in before the next release of scikit-image. So that changelist can gracefully deal with scikit-image/scikit-image#6695.